How to create a project and make it available to users

Creating a project and making it available to users is the responsibility of the Programme Lead.

It involves three steps. The first two steps involve assigning Registry entries. Once set, authorized users are able to commence working with a Form or, in the case of a Programme Lead, create and manage data entry Forms, Editors and Statistical graphs:

  1. Name the project: Project Title Registry entry.
  2. Define user access:
    • Assign permissions to users to determine what elements (Forms, Editors, Statistics) of the project they have access to: Project Dashboard Registry entry.

      Note: As with assigning permissions in EMu, it is good practice to assign permissions to a group and to make users members of the group. Permissions can be assigned to users, of course, and these will take precedence over group level permissions. See the EMu Help for details about the order in which Registry entries are assigned.

    • Define a user's role in a project: Project Role Registry entry.
    • Define which projects the user has access to: Project Registry entry.
  3. Create Forms and Editors, and Statistical graphs.

Registry entries

Name the project and define a unique project ID.

For this we use the following Registry entry:

 

User|user|Project|id|Title|project title

Group|group|Project|id|Title|project title

Group|Default|Project|id|Title|project title

where:

 

id

is a unique ID for the project.

It is recommended that id is constructed from letters, numbers, hyphens and underscores only.

id is referenced by other Registry entries that define who has access to what elements of the project.

 

project title

The name of the project as it will display to users when they log in to Sapphire.

If the user belongs to more than one project, a list of project titles will be presented.

Note: Typically a Group|Default setting is used.

Example

The following example provides a name and unique id for a Museum's Herbarium Digitization project:

Field

Value

Key 1

Group

Key 2

Default

Key 3

Project

Key 4

botany-herbarium

Key 5

Title

Value

Herbarium Imaging

Create a Dashboard with the project elements that users will have access to when they access a project.

For this we use the following Registry entry:

 

User|user|Project|id|Dashboard|element;element;...

Group|group|Project|id|Dashboard|element;element;...

Group|Default|Project|id|Dashboard|element;element;...

where:

 

id

is the unique ID for the project defined when the project was named (Name the project: Project Title Registry entry).

 

element;element;...

is a semicolon separated list of elements that the user / group will have access to when they access this project.

Values for element are:

  • Forms

    The user / group will have access to the project's Forms.

  • Editors

    The user / group will have access to the project's Editors.

  • Statistics

    The user / group will have access to statistical graphs configured for the project.

Project elements are displayed on the project Dashboard in the following order:

  • Forms
  • Editors
  • Statistics
Example

The following example provides user gerard with access to all available elements when working with the Herbarium Digitization project:

Field

Value

Key 1

User

Key 2

gerard

Key 3

Project

Key 4

botany-herbarium

Key 5

Dashboard

Value

Forms;Editors;Statistics

Define the roles of users and / or groups within the project.

For this we use the following Registry entry:

 

User|user|Project|id|Role|role

 

Group|group|Project|id|Role|role

 

Group|Default|Project|id|Role|role

where:

 

id

is the unique ID for the project defined when the project was named (Name the project: Project Title Registry entry).

 

role

is the role assigned to a user or group.

Values for role are:

  • lead

    The Programme Lead. The Programme Lead is able to create, configure and manage the project elements.

  • member

    Anyone other than the Programme Lead.
Example

The following example makes user gerard the Programme Lead for the Herbarium Digitization project:

Field

Value

Key 1

User

Key 2

gerard

Key 3

Project

Key 4

botany-herbarium

Key 5

Role

Value

lead

Specify which projects a user / group has access to and the order in which they will be listed when a user logs in to the project Dashboard.

For this we use the following Registry entry:

 

User|user|Project|id;id;...

 

Group|group|Project|id;id;...

 

Group|Default|Project|id;id;...

where:

 

id;id;...

is a semicolon separated list of project IDs defined when the project was named (Name the project: Project Title Registry entry).

The order in which the IDs are listed is the order in which they will be listed when a user logs in to the project Dashboard.
Example

The following example specifies that user gerard has access to two projects and the Herbarium Digitization project will be listed before the Palaeontology Imaging project:

Field

Value

Key 1

User

Key 2

gerard

Key 3

Projects

Value

botany-herbarium;paleo